home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / mkxrs102.arc / MKXRS.DOC < prev    next >
Text File  |  1991-01-12  |  14KB  |  313 lines
  1.  
  2.  
  3.  
  4.          ╔═══════════════════════════╗
  5.          ║ Mythical Kingdom Software ║    MKXRS - XRS Reply/Message Tosser
  6.          ║      ▄ ▄         ▄ ▄      ║
  7.          ║      ███  ▐▀ ▐▀  ███      ║              Version 1.02
  8.          ║      ███████████████      ║
  9.          ║      ██████░░░██████      ║    Copyright 1990, 1991 by Mark May
  10.          ║  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒  ║
  11.          ╚═══════════════════════════╝
  12.  
  13.  
  14.                                     Features
  15.                                     --------
  16.  
  17.          * Works with Remote Access / Quickbbs / Superbbs
  18.          * RA mulinode aware, uses environment variable to find system
  19.            directory and Config.RA to find everything else (searching
  20.            directories in the same order that RA does)
  21.          * Checks user security and flags against the message base write
  22.            security moving disallowed messages to a default area.
  23.          * Messages are put into the message base to appear that they
  24.            have been entered online, so that XRS can be used with Fido
  25.            technology or Non-Fido technology echos (such as RIME or
  26.            HyperMail or QWK based networks)
  27.          * Updates users record (via ExitInfo.Bbs) for messages posted
  28.          * Updates system log file to show messages posted
  29.          * Updates users record (via ExitInfo.Bbs) for Pending NetMail
  30.          * Checks users NetMail credit and moves messages over the limit
  31.            to the default message area.
  32.          * NetMail messages automatically clear the FileRequest and
  33.            FileAttach attributes to prevent security problems.
  34.          * Allows separate sysop definable costs for Normal Netmail,
  35.            Crash, Mail within your net, and InterZone NetMail
  36.          * Optionally allows you to force messages to use the UserRecord
  37.            name to improve security against hacked reply packets
  38.          * Optionally allows you to use your normal Bbs Origin line
  39.            (again a protection against hacked reply packets).
  40.          * Replies are tossed before user returns to Bbs
  41.          * Easy set-up just run MkXrsCfg and then add one line to your
  42.            RAQMX batch file to run MkXrs
  43.          * Automatic use of the correct unpack program (LZH/ZIP/ARC/
  44.            ZOO/ARJ/DWC/HYP) as long as they exist in any directory on the
  45.            Path or in the current directory.
  46.          * Sends private message to the sysop (in the default area)
  47.            to inform him/her about any messages that were moved to
  48.            the default area.
  49.          * Local mode operation option
  50.          * Free for any RA/Qbbs/Sbbs sysop
  51.          * Uses a swapping exec to call the unpacking programs leaving
  52.            less than 12K of MkXrs resident while the unpackers are
  53.            running.
  54.          * Duplicate message checking with configurable number of days
  55.  
  56.  
  57.                                     DISCLAIMER
  58.                                     ----------
  59.  
  60.           This set of programs comes without warranty neither expressed
  61.           nor implied.  It is your responsibility to see that these
  62.           programs meet your needs.  The author assumes no liability
  63.           for any damages or results that occur from using or the
  64.           inability to use these programs.  As with all bbs utilities,
  65.           there is some risk of problems even after testing, so full
  66.           and regular backups are important!  If you do not agree with
  67.           this disclaimer, you are prohibited from running these programs.
  68.           Running them confirms your agreement to these conditions.
  69.  
  70.  
  71.  
  72.  
  73.                                  Installation
  74.                                  ------------
  75.  
  76.          The programs MkXrs.Exe and MkXrsCfg.Exe should be copied to
  77.          any directory that is on your Dos path.  Then switch to the
  78.          main bbs directory (for Quickbbs or SuperBbs) or to each node
  79.          directory (for Remote Access) and run MkXrsCfg to create an
  80.          MkXrs.Cfg file that will be in the current directory when
  81.          MkXrs runs.  See section below for explanation of configuration
  82.          options.
  83.  
  84.          Because MkXrs updates ExitInfo.Bbs, you will want to install it
  85.          as a type 15 door on Quickbbs/SuperBbs, but may install it as
  86.          either a type 7 or type 15 door on Remote Access.  It must run
  87.          while the caller is still online so that everything will be
  88.          updated properly.  The easiest way to do this is to use the
  89.          sample batch file included here and add a menu choice like:
  90.  
  91.          For Remote Access use a Type 7 with optional data of
  92.  
  93.          *C /C RAQMX.BAT *M *!
  94.  
  95.          For Quickbbs or SuperBbs use a Type 15 with an errorlevel
  96.          and then add a line to your batch file to "Call RAQMX.BAT"
  97.          when it detects that errorlevel.
  98.  
  99.                                 Configuration
  100.                                 -------------
  101.  
  102.           MkXrsCfg presents a screen of fields and options that you
  103.           must set so that MkXrs will operate correctly.  To run it,
  104.           change to the directory that your node or bbs runs in and
  105.           run MkXrsCfg.  After setting the options press (Esc) to
  106.           save the changes and exit or Control-X to exit with no
  107.           without saving any changes.
  108.  
  109.           Bbs Path: For Quickbbs and SuperBbs, MkXrs needs to know
  110.              the path to the directory that contains your message
  111.              base files.  A trailing backslash will be automatically
  112.              added if needed.  For Remote Access the environment
  113.              variable and config files are used to locate the files
  114.              needed.
  115.  
  116.           XRS Packet Path: This is the path that your incomming
  117.              compressed XRS packets are uploaded to (usually
  118.              \QMX\).  Any compressed packets in this directory
  119.              are processed along with any uncompressed packets in
  120.              the current directory only.
  121.  
  122.           Use Bbs Origin: Forces the use of your normal Origin line
  123.              (including special origin lines for each message area
  124.              in an RA environment).  It will also cause the tearline
  125.              to be replaced by '--- ' followed by the text that you
  126.              put in the Config tearline field.
  127.  
  128.           Default Msg Area: When the user does not have the security
  129.              or flags to write to the area he requests, or if he is
  130.              sending netmail and doesn't have enough credit for it,
  131.              the message will instead be moved to this default
  132.              message area (should be a LOCAL message area).  This
  133.              area will also be used for messages to the sysop from
  134.              MkXRS indicating the reason messages were moved to the
  135.              default area.
  136.  
  137.          Bbs Type:  Choose either Remote Access, Quickbbs, or
  138.             SuperBbs from the picklist and press enter.
  139.  
  140.          Force User Name:  Forces all message to use the user name
  141.             from ExitInfo.Bbs instead of the name sent by the user.
  142.             This slightly improves security, but does eliminate the
  143.             use of alias names.
  144.  
  145.          NetMail Cost:  If the user has access to the NetMail message
  146.             area and sends a normal netmail message, this is the
  147.             message cost to use for netmail credit accounting.
  148.  
  149.          Crash NetMail Cost:  This is the cost to use when the
  150.             Netmail message is marked as a "crash" message.
  151.  
  152.          MyNet NetMail Cost:  This cost is used if the message is
  153.             being sent to another system in the same net as yours.
  154.  
  155.          InterZone NetMail Cost:  This is the cost when the message
  156.             contains an ^aINTL to indicate that it is being sent
  157.             to another zone.
  158.  
  159.          Use Direct Screen Writes:  Option to allow direct screen
  160.             writes for a full screen status display.  If you are
  161.             running a multitasker this option should be set to "N",
  162.             otherwise you probably should leave it set to "Y".
  163.  
  164.          Dupe Checking Days: The number of days old a prior message
  165.             can be that will still cause the current (matching)
  166.             message to be considered a dupelicate.  Note that the
  167.             4000 message storage limit may limit the effectiveness
  168.             of using a large number of days.  A large number of days
  169.             also (very slightly) increases the chance of falsely
  170.             flagging messages as duplicates.  I suggest a moderate
  171.             number like 7 to 14 days.
  172.  
  173.          Tear Line: When using the force Bbs origin option the
  174.             text here will be added to the tear line, even though
  175.             I personally prefer plain tearlines to avoid message
  176.             clutter.
  177.  
  178.  
  179.  
  180.                                   Problems
  181.                                   --------
  182.  
  183.          When problems are encountered an error message will be
  184.          displayed to the screen.   As a general rule, if the message
  185.          is "Unable to Open/Reset" a file, the problem is that the
  186.          named file couldn't be found.  In this case you should check
  187.          that the file does exist, and that the configuration gives the
  188.          correct path to find it.
  189.  
  190.          Messages such as "ErrorLevel ?? returned from unpacker"
  191.          indicate that the unpacking program (Lharc, PkUnzip, etc) have
  192.          indicated an error when they ran.  The meaning of the errorlevel
  193.          should be given in the documentation for the unpacker.  The most
  194.          common error is insufficient memory.  If this happens you should
  195.          switch to the batch file method of calling MkXrs instead of
  196.          having RQSEX140 calling it directly.
  197.  
  198.  
  199.  
  200.                               MultiNode Operation
  201.                               -------------------
  202.  
  203.          MkXrs follows the Remote Access style of message base locking.
  204.          When writing messages it opens MsgInfo.Bbs in ReadWrite/DenyWrite
  205.          mode which means that any other messages being entered at the
  206.          same time on other nodes must wait for this write to complete.
  207.          This appears to be the same technique (and result) that RA uses,
  208.          but may be more noticeable since MkXrs is tossing several messages
  209.          while an online user would only enter one at a time.  If this
  210.          causes too many delays, future versions may close the message
  211.          base after every "x" messages to minimize the disruptions.
  212.  
  213.          When tossing messages in a multinode environment, it is very
  214.          important that you have each nodes RAQMX inbound path set to
  215.          a different directory.  Otherwise MkXrs may attempt to toss a
  216.          partially uploaded packet or toss messages as if they were from
  217.          the wrong node's user.
  218.  
  219.  
  220.  
  221.                                  Local Mode
  222.                                  ----------
  223.  
  224.          To operate MkXrs in local mode, just change to the directory
  225.          that contains your MkXrs.Cfg file and type:
  226.  
  227.          MkXRS L FirstName LastName
  228.  
  229.          (replacing FirstName and LastName with the name of the person
  230.          who should be used as the message originator (to update msg
  231.          stats and netmail credit)
  232.  
  233.  
  234.                         Duplicate Message Checking
  235.                         --------------------------
  236.  
  237.          MkXrs maintains a file (MkXrs.Dup) of the CRC's of selected
  238.          portions of the messages tossed to the message base.   The
  239.          values are stored in an array based on the low order portion
  240.          of the Crc value.  This allows duplicate checking to be very
  241.          fast via a direct lookup (with limited collision handling),
  242.          but does mean that there is some (low) risk that duplicates
  243.          can slip thru.  The full CRC value is stored along with the
  244.          date the message was tossed.  If the date is older than the
  245.          configured number of days to check for dupes or the remainder
  246.          of the CRC does not match, then the message is not considered
  247.          to be a duplicate.  This approach should yield a very low risk
  248.          of false alarms on duplicates.
  249.  
  250.  
  251.  
  252.                              Free Registration          MKXRS v1.02
  253.                              -----------------
  254.  
  255.           NO registration fee is required for these programs.  I
  256.           initially wrote the utility to make operation of RAQMX
  257.           smoother on my own Bbs (especially with non-Fido technology
  258.           networks and want to make them freely available to other
  259.           sysops.  I'd like to hear from those that find the program
  260.           useful (especially any suggestions for improvements), and
  261.           have included a short form to make that convenient.
  262.  
  263.  
  264.          Registration Information:
  265.  
  266.  
  267.          Name:         _______________________________________________
  268.  
  269.          Address:      _______________________________________________
  270.  
  271.                        _______________________________________________
  272.  
  273.          City, ST Zip  _______________________________________________
  274.  
  275.  
  276.          Bbs Name:     _______________________________________________
  277.  
  278.          Bbs Type (Remote Access/Quickbbs/SuperBbs) __________________
  279.  
  280.          Bbs Phone Number  (     )        -
  281.  
  282.          Any suggestions or comments _________________________________
  283.  
  284.          _____________________________________________________________
  285.  
  286.          _____________________________________________________________
  287.  
  288.  
  289.          Registrations should be mailed to:
  290.  
  291.          Mark May
  292.          Mythical Kingdom Software
  293.          P.O. Box 24808
  294.          Huber Heights, OH 45424
  295.  
  296.  
  297.          You may leave questions or get the latest version by
  298.          calling:
  299.  
  300.          Mythical Kingdom Tech Bbs
  301.  
  302.          Phone              (513) 237-7737 9600 baud HST/V32
  303.          FidoNet            1:110/290
  304.          RIME (RelayNet)    ->MYTHKING
  305.          PNET
  306.  
  307.  
  308.  
  309.          -------------------------------------------------------------
  310.  
  311.          Note various software products mentioned are trademarks by
  312.          the respective owners.
  313.